Hybris UX Api

This operation allows to reserve or release from the inventory for below use cases:

1. Postpaid MSISDN, eSIM(ICCID), Fixed(logicalResource)
2. Prepaid MSISDN, eSIM(ICCID)

URL

http://[localhost]:[port]/ecom-ux/v1/{businessId}/logicalResource/{id}

URL PARAMS

Headers

Data Model - Request

relatedParty subResource -Data Model

resourceCharacteristic subResource -Data Model

Data Model - Response

relatedParty subResource -Data Model

resourceCharacteristic subResource -Data Model

Key considerations

Service number(MSISDN) usecase for PA

POSTPAID

- As this is implemented for mobile postpaid customers, if resourceCharacteristic[].name == "SERVICE" then value should be "POSTPAID".
- For MSISDN resourceCharacteristic[].name == "NumberArea" ,For FAST TRACK provisioning, the following value="MOV" is currently working in the Non-Prod environment. However, for the PROD instance, the channel must discuss and finalize the appropriate value with the business, which then need to be configured in the Liberate PROD instance.
- For MSISDN resourceCharacteristic[].name == "BillingAccount.id" then value should be customer billingAccount.
- To reserve/release a MSISDN, set the @type to MSISDN.
- To reserve a MSISDN, set the resourceStatus to "reserved".
- To release a MSISDN, set the resourceStatus to "available".
- If relatedParty[].'@referredType' == "Employee", the following relatedParty[].id value we need to pass employee code. However, for the PROD instance, the channel must discuss and finalize the appropriate values with the business, which then need to be configured in the Liberate PROD instance.
- For reserve/release MSISDN, refer to note section for API specification.

PREPAID

- As this is implemented for mobile prepaid customers, if resourceCharacteristic[].name == "SERVICE" then value should be "PREPAID".
- To reserve/release a MSISDN, set the @type to MSISDN.
- To reserve a MSISDN, set the resourceStatus to "reserved".
- To release a MSISDN, set the resourceStatus to "available".
- If relatedParty[].'@referredType' == "Customer" then Customer Name should be passed in relatedParty[].name
- For reserve/release MSISDN, refer to note section for API specification.

eSIM (ICCID) usecase for PA

POSTPAID

- As this is implemented for mobile postpaid customers, if resourceCharacteristic[].name == "SERVICE" then value should be "POSTPAID".
- To reserve/release a eSIM(ICCID), set the @type to ESIM.
- To reserve a eSIM(ICCID), set the resourceStatus to "reserved".
- To release a eSIM(ICCID), set the resourceStatus to "available".
- If relatedParty[].'@referredType' == "Employee" and relatedParty[].role == "authorizer" are given then employee number should be passed in relatedParty[].id
- If relatedParty[].'@referredType' == "Customer" then Customer billing account id should be passed in relatedParty[].id
- For reserve/release eSIM(ICCID), refer to note section for API specification.

PREPAID

- As this is implemented for mobile prepaid customers, if resourceCharacteristic[].name == "SERVICE" then value should be "PREPAID".
- To reserve/release a eSIM, set the @type to eSIM.
- To reserve a eSIM, set the resourceStatus to "reserved".
- To release a eSIM, set the resourceStatus to "available".
- If relatedParty[].'@referredType' == "Customer" then Customer Name should be passed in relatedParty[].name
- For reserve/release eSIM, refer to note section for API specification.

Service number(MSISDN) usecase for CWC

POSTPAID

- This is implemented for CWC markets CWC-Anguilla(AI), CWC-Antigua(AG), CWC-British Virgin Islands (BVI)(VG), CWC-Cayman(KY), CWC-Dominica(DM), CWC-Grenada(GD), CWC-Jamaica(JM), CWC-Montserrat(MS), CWC-St Kitts(KN), CWC-StVincent(VC), CWC-Turks&Caicos(TKI)(TC) for postpaid/Fixed customers.
- If resourceCharacteristic[].name = "SERVICE", (If it is Mobile set to  "POSTPAID" or If it is BLUU set to "Fixed".
- If resourceCharacteristic[].name = "NumberStatusReason" for MSISDN reservation, set its value to "17" (TBD - Pending confirmation from Liberate).
- If resourceCharacteristic[].name = "ServiceType", set its value to "CE" or "FD". (If it is  Mobile Postpaid , serviceType should be set as "CE" or If is Fixed Bluu serviceType should be set as "FD")
- If resourceCharacteristic[].name = "ReserveUntil", set the value to a future date/time when MSISDN should remain reserved.
- To reserve MSISDN, set @type = "MSISDN" and  resourceStatus = "reserved".
- If relatedParty[].@referredType = "customer", set relatedParty[].id = customerNumber.
- For PROD environment, final values must be confirmed with business and configured in Liberate PROD.
- For reserve MSISDN, refer to note section for API specification.

Value reference table - Response

eSIM (ICCID) usecase for CWC

POSTPAID

- This is implemented for CWC markets CWC-Anguilla(AI), CWC-Antigua(AG), CWC-British Virgin Islands (BVI)(VG), CWC-Cayman(KY), CWC-Dominica(DM), CWC-Grenada(GD), CWC-Jamaica(JM), CWC-Montserrat(MS), CWC-St Kitts(KN), CWC-StVincent(VC), CWC-Turks&Caicos(TKI)(TC) for postpaid/Fixed customers.
- If resourceCharacteristic[].name = "SERVICE", then set its value to "POSTPAID" because this setup is for postpaid mobile customers.
- To reserve an eSIM (ICCID), set @type = "ESIM" and resourceStatus = "reserved".
- If resourceCharacteristic[].name = "CardStatusReason" for ICCID, then its value must be "R".
- For PROD, the channel must confirm and finalize these values with the business team before configuring them in Liberate PROD.
- For reserve eSIM(ICCID), refer to note section for API specification.

Note : For request and response examples please refer to this URL Patch LogicalResource Specification